/* 
 * Copyright (c) 2012, Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *      * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *      * The names of its contributors may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Fromentin Xavier, Schnell Michaël, Dervin Cyrielle OR Brabant Quentin 
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package kameleon.document;

import java.util.Iterator;

import kameleon.exception.InvalidIndexException;

/**
 * Represents a link.
 * 
 * <p>Contains all of the informations concerning a given link.
 * The content of the link is stored as if it were a text paragraph.
 * 
 * <p>Standard properties include : none.
 * 
 * @author		Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * @version		1.0
 */
public class Link extends TextParagraphElement 
implements Iterable<TextParagraphElement> {

	/**
	 * Needed to serialize this class.
	 * 
	 * @see		java.io.Serializable
	 */
	private static final long serialVersionUID = -6330490648480601841L;

	/**
	 * Used to store the content of the link.
	 */
	public TextParagraph textParagraphs ;

	/**
	 * Builds an instance with no properties.
	 */
	public Link() {
		super();
		this.textParagraphs = new TextParagraph();
	}// Link()

	/**
     * Builds an instance with the given content.
     * 
     * @param 	tp
     * 			content for this link
     */
	public Link(TextParagraph tp) {
		this();
		this.textParagraphs = tp;
	}// Link()

	/**
	 * Add an instance of {@code TextParagraphElement} at the specified index.
	 * 
	 * @param 	p
	 * 			instance of {@code TextParagraphElement} added
	 * 
	 * @param 	index
	 * 			insert position
	 * 
	 * @throws	InvalidIndexException
	 * 			if the given index is out of range
	 * 			{@code index < 0 || index >= getCount()}
	 */
	public void add(TextParagraphElement p, int index) throws InvalidIndexException {
		this.textParagraphs.add(p, index) ;
	}// add(TextParagraphElement, int)

	/**
	 * Appends an instance of {@code TextParagraphElement} at the end of this instance
	 * of {@code TextParagraph}.
	 * 
	 * @param 	p
	 * 			instance of {@code TextParagraphElement} appended
	 * 
	 * @see		Elements#append(TextParagraphElement)
	 */
	public void append(TextParagraphElement p) {
		this.textParagraphs.append(p) ;
	}// append(TextParagraphElement)

	/**
	 * Removes the instance of {@code Paragraph} found at the given index.
	 * 
	 * @param 	index
	 * 			index of the removed {@code Paragraph}
	 * 
	 * @throws	InvalidIndexException
	 * 			if the given index is out of range
	 * 			{@code index < 0 || index >= getCount()}
	 */
	public void remove(int index) throws InvalidIndexException {
		this.textParagraphs.remove(index) ;
	}// remove(int)

	/**
	 * Removes all the instances matching the given {@code TextParagraphElement}.
	 * 
	 * @param 	p
	 * 			removed {@code TextParagraphElement}
	 */
	public void remove(TextParagraphElement p) {
		this.remove(p) ;
	}// remove(TextParagraphElement)

	/**
	 * Returns the number of instance of {@code TextParagraphElement} contained 
	 * in this instance.
	 * 
	 * @return	Number of instance of {@code TextParagraphElement} contained 
	 * 			in this instance
	 */
	public int getCount() {
		return this.textParagraphs.getCount() ;
	}// getCount()

	/**
	 * Returns an iterator for this instance.
	 * 
	 * <p>The iterator iterates over the text content sequentially.
	 * 
	 * @return	An instance of {@code Iterator<TextParagraphElement>} for this instance
	 */
	@Override
	public Iterator<TextParagraphElement> iterator() {
		return this.textParagraphs.iterator() ;
	}// iterator()

	/**
	 * Returns the whole text of this instance.
	 * 
	 * @return	Instance of {@code TextParagraph} containing the whole text
	 */
	public TextParagraph getText() {
		return this.textParagraphs ;
	}// getText()

}// class Link